<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Karamelo: region_block</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="karamelodoxy.css" rel="stylesheet" type="text/css">
<!--  -->
<script type="text/javascript" src="karamelo_navtree_hacks.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.karamelo.org"><img alt="Logo" src="Karamelo_logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://www.karamelo.org">Karamelo</a>
   &#160;<span id="projectnumber">5b95c290</span>
   </div>
   <div id="projectbrief">Parallel Material Point Method Simulator</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__regionblock.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">region_block</div>  </div>
</div><!--header-->
<div class="contents">
<p>Initializes variables and generates the map of known region types (at compile time).</p>
<h1><a class="anchor" id="Syntax"></a>
Syntax</h1>
<div class="fragment"><div class="line">region(region-ID, block, xmin, xmax, ymin, ymax, zmin, zmax)</div></div><!-- fragment --><ul>
<li>
region-ID: name of the region to be created. </li>
<li>
xmin, xmax: lower and upper boundaries along the x axis. </li>
<li>
ymin, ymax: lower and upper boundaries along the y axis. Optional if dimension is 1D. </li>
<li>
zmin, zmax: lower and upper boundaries along the z axis. Optional if dimension is 1D or 2D. </li>
</ul>
<h1><a class="anchor" id="Examples"></a>
Examples</h1>
<div class="fragment"><div class="line">region(A, block, 0, L, 0, 2*L)</div></div><!-- fragment --><p> Defines a 2D rectangular region called 'A'. A point of coordinates (x, y, z) lies within the region if <img class="formulaInl" alt="$0 \leq x \leq L$" src="form_18.png"/> and <img class="formulaInl" alt="$0 \leq y \leq 2L$" src="form_20.png"/>.</p>
<h1><a class="anchor" id="Description"></a>
Description</h1>
<p>This command defines a rectangle region of space. It is usually used by groups to find what nodes and/or particles lie within a specific region of space. A region does not select nodes or particles. </p>
<h1><a class="anchor" id="Syntax"></a>
Syntax</h1>
<div class="fragment"><div class="line">region(region-ID, block, xmin, xmax, ymin, ymax, zmin, zmax)</div></div><!-- fragment --><ul>
<li>
region-ID: name of the region to be created. </li>
<li>
xmin, xmax: lower and upper boundaries along the x axis. </li>
<li>
ymin, ymax: lower and upper boundaries along the y axis. Optional if dimension is 1D. </li>
<li>
zmin, zmax: lower and upper boundaries along the z axis. Optional if dimension is 1D or 2D. </li>
</ul>
<h1><a class="anchor" id="Examples"></a>
Examples</h1>
<div class="fragment"><div class="line">region(A, block, 0, L, 0, 2*L)</div></div><!-- fragment --><p> Defines a 2D rectangular region called 'A'. A point of coordinates (x, y, z) lies within the region if <img class="formulaInl" alt="$0 \leq x \leq L$" src="form_18.png"/> and <img class="formulaInl" alt="$0 \leq y \leq 2L$" src="form_20.png"/>.</p>
<h1><a class="anchor" id="Description"></a>
Description</h1>
<p>This command defines a rectangle region of space. It is usually used by groups to find what nodes and/or particles lie within a specific region of space. A region does not select nodes or particles.</p>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Fri May 15 2020 17:44:04 for Karamelo by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
<!-- Matomo -->
<script type="text/javascript">
  var _paq = _paq || [];
  /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
  _paq.push(['trackPageView']);
  _paq.push(['enableLinkTracking']);
  (function() {
    var u="//stats.sylphide-consulting.com/matomo/";
    _paq.push(['setTrackerUrl', u+'piwik.php']);
    _paq.push(['setSiteId', '20']);
    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
    g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
  })();
</script>
<noscript><p><img src="//stats.sylphide-consulting.com/matomo/piwik.php?idsite=20&rec=1" style="border:0;" alt="" /></p></noscript>
<!-- End Matomo Code -->
</body>
</html>
